/*
 * Copyright © 2018 www.noark.xyz All Rights Reserved.
 *
 * 感谢您选择Noark框架，希望我们的努力能为您提供一个简单、易用、稳定的服务器端框架 ！
 * 除非符合Noark许可协议，否则不得使用该文件，您可以下载许可协议文件：
 *
 *        http://www.noark.xyz/LICENSE
 *
 * 1.未经许可，任何公司及个人不得以任何方式或理由对本框架进行修改、使用和传播;
 * 2.禁止在本项目或任何子项目的基础上发展任何派生版本、修改版本或第三方版本;
 * 3.无论你对源代码做出任何修改和改进，版权都归Noark研发团队所有，我们保留所有权利;
 * 4.凡侵犯Noark版权等知识产权的，必依法追究其法律责任，特此郑重法律声明！
 */
package xyz.noark.core.annotation.controller;

import xyz.noark.core.network.Session;

import java.lang.annotation.*;

/**
 * CommandMapping注解用来标识一个封包映射到一个处理方法.
 * <p>
 * 区别于{@link PacketMapping}在于协议编号类型为字符串
 *
 * @author 小流氓[176543888@qq.com]
 * @since 3.4
 */
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CommandMapping {

    /**
     * 字符串类型的协议编号.
     *
     * @return 协议编号
     */
    String opcode();

    /**
     * 如果字符串类型的协议编号中需要填充配置参数，则使用此属性来标识.
     * <p>如：@CommandMapping(opcode="a.b.{0}.d", formatKey="xx.xx.xx")</p>
     *
     * @return 填充参数
     */
    String[] formatKey() default {};

    /**
     * @return 如果是内部协议，此使用此属性来标识
     */
    boolean inner() default false;

    /**
     * 是否需要打印协议相关的日志.
     *
     * @return 默认为输出日志
     */
    boolean printLog() default true;

    /**
     * 当前状态才可以调用的执行方法.
     * <p>
     * 当登录协议需要设定为链接状态
     *
     * @return 默认为游戏中状态
     */
    Session.State[] state() default Session.State.INGAME;
}